yMap

Description

The yMap component serves as a powerful tool primarily designed for displaying a video. It's an adaptable element that allows both static and dynamic content.

Some uses for the yMap are:

• External search
• Loading search results as an option list
• Setting current location with GPS
• Loading location data from database

Basic Structure

In the following the basic structure of the yMap shall be explained. For the general structure of a yComponent please visit the yBase-components basic-structure.

Map

The map represents the actual map module itself, offering a view of a map with attached user interactions.

Search control

The search control is an element which offers the ability to search for locations. It can be displayed in different forms and is adjustable.

Routing panel

The routing panel accomodates different possibilty for setting routes on the map and navigating from A to B.

Zoom control

The zoom control is another customizable control element, which lets the user adjust the zoom of the displayed map.

Properties

Through its various properties the yMap can be configured to suit your needs. The display below provides you with an overview of all the yMap properties.

Properties can be changed directly through three methods:

• Inside the Toolbar, which is positioned in your workarea next to your component right where you need it. It shows the most important properties, thus providing a fast and efficient way to configure your component in the most basic way.
• It may also occur in the Toolbar Extension, which is a seamless extension accesible as a dropdown item of the Toolbar. It extends the functionality of the Toolbar by providing advanced pickers for the most used properties.
• Inside the Detail Panel, which is located in the righthand drawer. Every property of a component can be configured here.

Generic

METAread more

Name: componentId

Not Editable

Number Property

--y-map__component-id

The identifier of the component that is unique within a page.

Name: componentType

Not Editable

String Property

--y-map__component-type

The type of the component. For this component it is -map.

Name: name

String Property

--y-map__name

The custom name of the component. It serves for better identification of the component.

Name: version

String Property

--y-map__version

The custom version of the Map-component. This can be used to ensure that all components work well together.

Name: coreTheme

String Property

--y-map__core-theme

The CoreTheme, which will be apllied to the Map. For further information on themes visit the themes page.

Name: subTheme

String Property

--y-map__sub-theme

The subtheme subordinated to the previously specified CoreTheme, which will be apllied to the Map. For further information on themes visit the themes page.

Name: groupTheme

String Property

--y-map__group-theme

The group theme is a further variation of the subtheme which is specified especially for variations of a component inside the subtheme. For further information on themes visit the Theme-Manager page.

DISPLAYread more

Name: display

String Property

--y-map__display

This property specifies the display behavior of the component. This can be be set to:

• none
• block
• flex
• inline

Name: position

Not Editable

String Property

--y-map__position

This property specifies the type of positioning method used for the component. This can be be set to:

• static
• relative
• absolute
• sticky
• fixed

Name: visible

String Property

--y-map__visible

This property can toggle the visibility of the component. The two modes are completely hidden and fully shown.

SIZEread more

Name: minWidth

Injectable

UnitNumber Property

--y-map__min-width

The minimum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: minHeight

Injectable

UnitNumber Property

--y-map__min-height

The minimum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %

Name: width

Injectable

UnitNumber Property

--y-map__width

The value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: height

Injectable

UnitNumber Property

--y-map__height

The value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• auto

Name: maxWidth

Injectable

UnitNumber Property

--y-map__max-width

The maximum value for the width of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: maxHeight

Injectable

UnitNumber Property

--y-map__max-height

The maximum value for the height of the component. This can be set in:

• px
• pt
• em
• vw
• vh
• %
• none

Name: flex

String Property

--y-map__flex

The flex property sets the length on flexible items. This sets the value in n-fold shares extrapolated to all other components with the flex display within the same container.

PLACEMENTread more

Name: marginTop

Injectable

UnitNumber Property

--y-map__margin-top

This property creates a space around the component, outside of the top border. This can be set in percent or pixels.

Name: marginRight

Injectable

UnitNumber Property

--y-map__margin-right

This property creates a space around the component, outside of the right border. This can be set in percent or pixels.

Name: marginBottom

Injectable

UnitNumber Property

--y-map__margin-bottom

This property creates a space around the component, outside of the bottom border. This can be set in percent or pixels.

Name: marginLeft

Injectable

UnitNumber Property

--y-map__margin-left

This property creates a space around the component, outside of the left border. This can be set in percent or pixels.

Name: paddingTop

Injectable

UnitNumber Property

--y-map__padding-top

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Name: paddingRight

Injectable

UnitNumber Property

--y-map__padding-right

This property creates a space within the component, inside of the right border. This can be set in percent or pixels.

Name: paddingBottom

Injectable

UnitNumber Property

--y-map__padding-bottom

This property creates a space within the component, inside of the bottom border. This can be set in percent or pixels.

Name: paddingLeft

Injectable

UnitNumber Property

--y-map__padding-left

This property creates a space within the component, inside of the top border. This can be set in percent or pixels.

Style

BACKGROUNDread more

Name: bgColor

Injectable

Color Property

--y-map__bg-color

--y-map__bg-color__normal

--y-map__bg-color__hover

--y-map__bg-color__focus

--y-map__bg-color__disabled

The color of the background. This can be set as a color from a palette or a custom hex color.

BORDERread more

Name: borderTopColor

Injectable

Color Property

--y-map__border-top-color

--y-map__border-top-color__normal

--y-map__border-top-color__hover

--y-map__border-top-color__focus

--y-map__border-top-color__disabled

The color of the top border. This can be set as a color from a palette or a custom hex color.

Name: borderTopStyle

Injectable

String Property

--y-map__border-top-style

--y-map__border-top-style__normal

--y-map__border-top-style__hover

--y-map__border-top-style__focus

--y-map__border-top-style__disabled

The style of the top border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderTopWidth

Injectable

UnitNumber Property

--y-map__border-top-width

--y-map__border-top-width__normal

--y-map__border-top-width__hover

--y-map__border-top-width__focus

--y-map__border-top-width__disabled

The width of the top border. This can be set in percent or pixels.

Name: borderRightColor

Injectable

Color Property

--y-map__border-right-color

--y-map__border-right-color__normal

--y-map__border-right-color__hover

--y-map__border-right-color__focus

--y-map__border-right-color__disabled

The color of the right border. This can be set as a color from a palette or a custom hex color.

Name: borderRightStyle

Injectable

String Property

--y-map__border-right-style

--y-map__border-right-style__normal

--y-map__border-right-style__hover

--y-map__border-right-style__focus

--y-map__border-right-style__disabled

The style of the right border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderRightWidth

Injectable

UnitNumber Property

--y-map__border-right-width

--y-map__border-right-width__normal

--y-map__border-right-width__hover

--y-map__border-right-width__focus

--y-map__border-right-width__disabled

The width of the right border. This can be set in percent or pixels.

Name: borderBottomColor

Injectable

Color Property

--y-map__border-bottom-color

--y-map__border-bottom-color__normal

--y-map__border-bottom-color__hover

--y-map__border-bottom-color__focus

--y-map__border-bottom-color__disabled

The color of the bottom border. This can be set as a color from a palette or a custom hex color.

Name: borderBottomStyle

Injectable

String Property

--y-map__border-bottom-style

--y-map__border-bottom-style__normal

--y-map__border-bottom-style__hover

--y-map__border-bottom-style__focus

--y-map__border-bottom-style__disabled

The style of the bottom border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderBottomWidth

Injectable

UnitNumber Property

--y-map__border-bottom-width

--y-map__border-bottom-width__normal

--y-map__border-bottom-width__hover

--y-map__border-bottom-width__focus

--y-map__border-bottom-width__disabled

The width of the bottom border. This can be set in percent or pixels.

Name: borderLeftColor

Injectable

Color Property

--y-map__border-left-color

--y-map__border-left-color__normal

--y-map__border-left-color__hover

--y-map__border-left-color__focus

--y-map__border-left-color__disabled

The color of the left border. This can be set as a color from a palette or a custom hex color.

Name: borderLeftStyle

Injectable

String Property

--y-map__border-left-style

--y-map__border-left-style__normal

--y-map__border-left-style__hover

--y-map__border-left-style__focus

--y-map__border-left-style__disabled

The style of the left border. This can be be set to:

• solid
• dotted
• dashed
• none

Name: borderLeftWidth

Injectable

UnitNumber Property

--y-map__border-left-width

--y-map__border-left-width__normal

--y-map__border-left-width__hover

--y-map__border-left-width__focus

--y-map__border-left-width__disabled

The width of the left border. This can be set in percent or pixels.

Name: borderRadius

Injectable

UnitNumber Property

--y-map__border-radius

The radius of the corners of all the borders. This can be set in percent or pixels.

SHADOWread more

Name: boxShadow

Injectable

String Property

--y-map__box-shadow

--y-map__box-shadow__normal

--y-map__box-shadow__hover

--y-map__box-shadow__focus

--y-map__box-shadow__disabled

The shadow of the component. This is set by the 4 sub-properties x, y, blur and spread of the shadow-property, which can be further read about in the shadow-property section.

OPACITYread more

Name: opacity

Injectable

Number Property

--y-map__opacity

--y-map__opacity__normal

--y-map__opacity__hover

--y-map__opacity__focus

--y-map__opacity__disabled

The opacity of all colored parts of the component. This value is set in percent.

Map

STATEread more

Name: disabled

Boolean Property

--y-map__disabled

This property can disable or enable the disabled-state of the Map-component.

Links

VIDEOread more

Name: sourceVideo

String Property

--y-map__source-video

This property defines a link to another component by specifying the componentId or componentName, Page, Component, ID, Event. The data from the link will represent the source of the video.

Events

LIFECYCLEread more

Name: EvtInit

String Property

--y-map__-evt-init

This specifies the function to be called, when the Map is initialized.

INPUTread more

Name: EvtPlay

String Property

--y-map__-evt-play

The event that is triggered once the video gets played.

Name: EvtPause

String Property

--y-map__-evt-pause

The event that is triggered once the video is paused.

Usage

In this section you will find a collection of application scenarios and examples that illustrate how to leverage the yMap in ways that deviate from its standard behavior, as defined by yBase. This section aims to inspire and guide you through various possibilities, helping you to implement more complex or unique functionalities tailored to your specific needs. General properties that are universally applicable can be found in the yBase usage section.

External search

Being eager to search from a custom input field which can be styled further or searching based on values being set inside a clipboard or yTable, the corresponding source link enables to do this without the need of coding.

How to:

1. Create a yInput inside your page.
2. Select the yMap again.
3. Open the Detail Panel and navigate to the Links category to open the Search group.
4. Now create a SourceLink to the input-string event of your yInput.

Loading search results as an option list

With the yMap component, you can execute an external search. Furthermore, you can even load the search results provided by the map.

As prerequisites, proceed to execute External search and come back to this example when done.

How to:

1. Open the Detail Panel and proceed to Events, unfold Search to modify EvtSearch.
2. Associate a custom JavaScript function to the yMap. This function will be invoked every time an external search is done.
3. Include the provided JavaScript snippet below to implement a loading function.

Code example:

With this script, each search triggers this function to invoke new data inside a ySelectionPicker.

Map EvtSearch

// function onMap_2_EvtSearch (apiObject, component, eventData) {

const results = [];

eventData.data.forEach((entry) => {
  results.push(
    new apiObject.types.optionListValue([entry.x, entry.y], entry.label)
  );
});

const select = apiObject.ui.getObject(3, "y-selection-picker", "y-page", 1);
select.set("style", "list", "optionList", results);
// }

Setting current location with GPS

The current yMap allows the developer to directly locate the user and create a marker. This can be done without any coding, by toggling allowLocate.

How to:

1. Open the Detail Panel and navigate to the Style category to open the Map group.
2. Now toggle allowLocate to true and allow the determination of your current location via the notification of the browser.

Loading location data from database

The yMap component enables you to load data received from outside and center the map itself.

For instance, you could set up a function that gets executed when selecting a table record, which contains location data of a customer.

How to:

1. Create a yTable in your application.
2. Open the Detail Panel and proceed to Events, unfold Input to modify EvtListSelect.
3. Associate a custom JavaScript function to the yMap. This function will be invoked every time a record of the table is selected.
4. Include the provided JavaScript snippet below.

Code example:

With this script, each selection of a table record will center the map, based on the coordinates provided by the record.

Table EvtListSelect

// function onTable_3_EvtListSelect (apiObject, component, eventData) {
// get lat and lng which is  written as xx,xx;yy,yy
const data = eventData.data[0];
const values = data.location.split(";");

const lat = values[0];
const lng = values[1];

const myMap = apiObject.ui.getObject(2, "y-map", "y-page", 1);
myMap.set("style", "map", "centerCoordinateLat", parseInt(lat));
myMap.set("style", "map", "centerCoordinateLng", parseInt(lng));
// }